Resource /webmapi/igroups/{id}Expand | Collapse

APIs for grouping host initiators

Get the specified initiator group instance
Description

Get the specified initiator group instance

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

GET /webmapi/igroups/{id}

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<IGroupInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
IGROUP_SHOW_IGROUP_NOT_FOUND6000Initiator group not found.
Produces

application/json

Since

1.0

Destroy an initiator group
Description

Destroy an initiator group

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

DELETE /webmapi/igroups/{id}?force=param0

Query Parameters:
forceForces the operation (required=false, default=false).

Format: ?force={true|false}

Example: ?force=true

True will forcefully perform the operation. Default is false.

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
IGROUP_DESTROY_IGROUP_NOT_FOUND6014Initiator group not found.
IGROUP_DESTROY_IGROUP_HAS_MAPS6015Initiator group could not be destroyed because it has maps.
IGROUP_DESTROY_INTERNAL_ERROR6016Unable to fetch information internally.
IGROUP_DESTROY_DISCARDED6022Internal error occurred and the operation was discarded. This is usually a transient error.
Produces

application/json

Since

1.0